Adding large project instructions. Cleaning up various navigation issues#76
Adding large project instructions. Cleaning up various navigation issues#76kellrott wants to merge 2 commits intorefactor/new-sitefrom
Conversation
✅ Deploy Preview for calypr ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation for managing large-scale Git LFS projects and cleans up navigation inconsistencies across the documentation site. The changes improve documentation organization and fix several spelling errors in existing content.
Changes:
- Added new comprehensive guide for managing large-scale Git LFS repositories with thousands of files
- Fixed spelling errors in configuration documentation ("Paramaters" → "Parameters")
- Reorganized tools index page and improved navigation structure consistency
- Updated project creation documentation with clearer beta status information
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/calypr/project-management/large-projects.md | New comprehensive guide on managing Git LFS repositories with thousands of files, including architectural patterns and best practices |
| docs/tools/sifter/docs/config.md | Corrected spelling of "Parameters" in title and heading |
| docs/tools/index.md | Reorganized tool descriptions, removed "Choosing the Right Tool" table, added Forge, Data Client, and Sifter sections |
| docs/tools/git-drs/.nav.yml | Restructured navigation with expanded entries for installation, getting started, and commands |
| docs/tools/data-client/index.md | Removed reference to deprecated calypr_admin tool |
| docs/tools/.nav.yml | Added explicit navigation structure for all tool subdirectories |
| docs/tools/sifter/index.md | Added repository URL metadata |
| docs/calypr/project-management/create-project.md | Updated beta status information with clearer formatting |
| docs/calypr/project-management/.nav.yml | Added navigation entry for large-projects.md |
| docs/calypr/.nav.yml | Added explicit index.md entry to navigation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| Status: *Manual and DevOps‑only at the moment* | ||
| !!! info "Private Beta" | ||
| Project creation is currently is a admin operation and not avalible to users. You will need to request |
There was a problem hiding this comment.
Grammar error: "currently is a admin" should be "currently an admin" (remove the duplicate "is" and change "a" to "an").
| Project creation is currently is a admin operation and not avalible to users. You will need to request | |
| Project creation is currently an admin operation and not available to users. You will need to request |
|
|
||
| ### [Forge](forge/index.md) | ||
| **Project formatting** | ||
| Forge scans a data repository to build an integrated FHIR based graph of samples and all the files connected to the project. It is resposible for schema checking and database loading. You can use it client side to verify and debug your project and on the server side, it is used to load databases. |
There was a problem hiding this comment.
Spelling error: "resposible" should be "responsible".
| Forge scans a data repository to build an integrated FHIR based graph of samples and all the files connected to the project. It is resposible for schema checking and database loading. You can use it client side to verify and debug your project and on the server side, it is used to load databases. | |
| Forge scans a data repository to build an integrated FHIR based graph of samples and all the files connected to the project. It is responsible for schema checking and database loading. You can use it client side to verify and debug your project and on the server side, it is used to load databases. |
| - Getting Started: getting-started.md | ||
| - Commands: commands.md | ||
| # - Developer Guide: developer-guide.md | ||
| - Trouble shooting: troubleshooting.md |
There was a problem hiding this comment.
Inconsistent spelling: "Trouble shooting" should be "Troubleshooting" (one word) to match the previous usage in line 8 of the original file.
| - Trouble shooting: troubleshooting.md | |
| - Troubleshooting: troubleshooting.md |
| @@ -1,5 +1,10 @@ | |||
| title: Git-DRS | |||
| nav: | |||
| - index.md | |||
There was a problem hiding this comment.
The navigation file has a duplicate entry for "index.md". Line 3 has a bare "index.md" entry and line 4 has "Overview: index.md" which both point to the same file. This creates redundancy in the navigation structure.
| - index.md |
|
The section included in the calypr pages includes sections like "Introduce a canonical LFS index" which, when written, was intended to guide the developer. Suggest rereading, editing, and changing voice to a user centered one. The 'sparse checkout' section was written with users in mind. Analyst experience with gdc-mirror should guide editing, ie "what works, what doesn't" |
2 participants
No description provided.